﻿namespace YAF.Lucene.Net.Search.VectorHighlight
{
    /*
	 * Licensed to the Apache Software Foundation (ASF) under one or more
	 * contributor license agreements.  See the NOTICE file distributed with
	 * this work for additional information regarding copyright ownership.
	 * The ASF licenses this file to You under the Apache License, Version 2.0
	 * (the "License"); you may not use this file except in compliance with
	 * the License.  You may obtain a copy of the License at
	 *
	 *     http://www.apache.org/licenses/LICENSE-2.0
	 *
	 * Unless required by applicable law or agreed to in writing, software
	 * distributed under the License is distributed on an "AS IS" BASIS,
	 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	 * See the License for the specific language governing permissions and
	 * limitations under the License.
	 */

    /// <summary>
    /// <see cref="IFragListBuilder"/> is an interface for <see cref="FieldFragList"/> builder classes.
    /// A <see cref="IFragListBuilder"/> class can be plugged in to <see cref="Highlight.Highlighter"/>.
    /// </summary>
    public interface IFragListBuilder
    {
        /// <summary>
        /// create a <see cref="FieldFragList"/>.
        /// </summary>
        /// <param name="fieldPhraseList"><see cref="FieldPhraseList"/> object</param>
        /// <param name="fragCharSize">the length (number of chars) of a fragment</param>
        /// <returns>the created <see cref="FieldFragList"/> object</returns>
        FieldFragList CreateFieldFragList(FieldPhraseList fieldPhraseList, int fragCharSize);
    }
}
